SureTax Returns API

GET Submission Request Status

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This endpoint is used to retrieve the current status of a submission request for a specific form instance. This status provides information about whether the form submission was successful, failed, or is still in progress. It allows users to track the processing state of their form submissions and respond accordingly

OperationId: GET Submission Request Status

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/SubmissionRequestStatus

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

SubmissionRequestStatusResponse

OVERVIEWEXAMPLE

Overview

SubmissionRequestStatusResponse

Display Name	Field Name	Field Type
Data	data	array[SubmissionRequestStatus]

SubmissionRequestStatus

Display Name	Field Name	Field Type
Request Status	requestStatus	string
Form Instances	formInstances	array[FormInstancesStatus]

FormInstancesStatus

Display Name	Field Name	Field Type
Id	id	string
Responses	responses	array[ResponsesStatus]

ResponsesStatus

Display Name	Field Name	Field Type
Status	status	string
Timestamp	timestamp	string
Message	message	string
Response File Id	responseFileId	string
Request File Id	requestFileId	string

Example Response

{
  "data": [
    {
      "requestStatus": "1",
      "formInstances": [
        {
          "id": "acf10f21-ccc5-499c-b3e9-e02288c997f0",
          "responses": [
            {
              "status": "SUI",
              "timestamp": "2024-01-01 05:40:25",
              "message": "ABC",
              "responseFileId": "ab1cd227-b009-4cbf-9311-1a49b9523441",
              "requestFileId": "47265480-a067-4fc9-9d25-fd1964ad8a67"
            }
          ]
        }
      ]
    }
  ]
}

Response Codes

code	description
200	The API response contains the status for a deletion process. Success Response - 200 OK. The API will respond with the current status of the process.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/SubmissionRequestStatus

Add Request Headers: